|
|
RmvTime |
||||
| Header: | Timer.h | Carbon status: | Supported | |
Removes a task from the Time Manager queue.
void RmvTime (
QElemPtr tmTaskPtr
);
A pointer to a task structure to be removed from the queue.
The RmvTime function removes the Time Manager task structure specified by tmTaskPtr from the Time Manager queue. In both the revised and extended Time Managers, if the specified task structure is active (that is, if it has been activated but the specified time has not yet elapsed), the tmCount field of the task structure returns the amount of time remaining. To provide the greatest accuracy, the unused time is reported as negated microseconds if that value is small enough to fit into the tmCount field (even if the delay was originally specified in milliseconds); otherwise, the unused time is reported in positive milliseconds. If the time has already expired, tmCount contains 0.
In the revised and extended Time Managers, RmvTime sets the high-order bit of the qType field to 0.
Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.
© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)